

<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<head>
  <meta charset="utf-8" /><meta name="viewport" content="width=device-width, initial-scale=1" />

  <meta name="viewport" content="width=device-width, initial-scale=1.0" />
  <title>Group &mdash; O365  documentation</title>
      <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=b86133f3" />
      <link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=e59714d7" />

  
      <script src="../_static/jquery.js?v=5d32c60e"></script>
      <script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
      <script src="../_static/documentation_options.js?v=5929fcd5"></script>
      <script src="../_static/doctools.js?v=9bcbadda"></script>
      <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
    <script src="../_static/js/theme.js"></script>
    <link rel="index" title="Index" href="../genindex.html" />
    <link rel="search" title="Search" href="../search.html" />
    <link rel="next" title="Mailbox" href="mailbox.html" />
    <link rel="prev" title="Excel" href="excel.html" />
    <link href="../_static/css/style.css" rel="stylesheet" type="text/css">

</head>

<body class="wy-body-for-nav"> 
  <div class="wy-grid-for-nav">
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
        <div class="wy-side-nav-search" >

          
          
          <a href="../index.html">
            
          </a>
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" aria-label="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>
        </div><div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="Navigation menu">
              <p class="caption" role="heading"><span class="caption-text">Contents:</span></p>
<ul class="current">
<li class="toctree-l1"><a class="reference internal" href="../overview.html">Overview</a></li>
<li class="toctree-l1"><a class="reference internal" href="../getting_started.html">Getting Started</a></li>
<li class="toctree-l1"><a class="reference internal" href="../usage.html">Detailed Usage</a></li>
<li class="toctree-l1 current"><a class="reference internal" href="../api.html">O365 API</a><ul class="current">
<li class="toctree-l2"><a class="reference internal" href="account.html">Account</a></li>
<li class="toctree-l2"><a class="reference internal" href="address_book.html">Address Book</a></li>
<li class="toctree-l2"><a class="reference internal" href="calendar.html">Calendar</a></li>
<li class="toctree-l2"><a class="reference internal" href="category.html">Category</a></li>
<li class="toctree-l2"><a class="reference internal" href="connection.html">Connection</a></li>
<li class="toctree-l2"><a class="reference internal" href="directory.html">Directory</a></li>
<li class="toctree-l2"><a class="reference internal" href="excel.html">Excel</a></li>
<li class="toctree-l2 current"><a class="current reference internal" href="#">Group</a><ul>
<li class="toctree-l3"><a class="reference internal" href="#O365.groups.Group"><code class="docutils literal notranslate"><span class="pre">Group</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.__init__"><code class="docutils literal notranslate"><span class="pre">Group.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.get_group_members"><code class="docutils literal notranslate"><span class="pre">Group.get_group_members()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.get_group_owners"><code class="docutils literal notranslate"><span class="pre">Group.get_group_owners()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.description"><code class="docutils literal notranslate"><span class="pre">Group.description</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.display_name"><code class="docutils literal notranslate"><span class="pre">Group.display_name</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.mail"><code class="docutils literal notranslate"><span class="pre">Group.mail</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.mail_nickname"><code class="docutils literal notranslate"><span class="pre">Group.mail_nickname</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.object_id"><code class="docutils literal notranslate"><span class="pre">Group.object_id</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.type"><code class="docutils literal notranslate"><span class="pre">Group.type</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Group.visibility"><code class="docutils literal notranslate"><span class="pre">Group.visibility</span></code></a></li>
</ul>
</li>
<li class="toctree-l3"><a class="reference internal" href="#O365.groups.Groups"><code class="docutils literal notranslate"><span class="pre">Groups</span></code></a><ul>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Groups.__init__"><code class="docutils literal notranslate"><span class="pre">Groups.__init__()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Groups.get_group_by_id"><code class="docutils literal notranslate"><span class="pre">Groups.get_group_by_id()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Groups.get_group_by_mail"><code class="docutils literal notranslate"><span class="pre">Groups.get_group_by_mail()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Groups.get_user_groups"><code class="docutils literal notranslate"><span class="pre">Groups.get_user_groups()</span></code></a></li>
<li class="toctree-l4"><a class="reference internal" href="#O365.groups.Groups.list_groups"><code class="docutils literal notranslate"><span class="pre">Groups.list_groups()</span></code></a></li>
</ul>
</li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="mailbox.html">Mailbox</a></li>
<li class="toctree-l2"><a class="reference internal" href="message.html">Message</a></li>
<li class="toctree-l2"><a class="reference internal" href="onedrive.html">One Drive</a></li>
<li class="toctree-l2"><a class="reference internal" href="planner.html">Planner</a></li>
<li class="toctree-l2"><a class="reference internal" href="sharepoint.html">Sharepoint</a></li>
<li class="toctree-l2"><a class="reference internal" href="tasks.html">Tasks</a></li>
<li class="toctree-l2"><a class="reference internal" href="teams.html">Teams</a></li>
<li class="toctree-l2"><a class="reference internal" href="utils.html">Utils</a></li>
</ul>
</li>
</ul>

        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"><nav class="wy-nav-top" aria-label="Mobile navigation menu" >
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="../index.html">O365</a>
      </nav>

      <div class="wy-nav-content">
        <div class="rst-content">
          <div role="navigation" aria-label="Page navigation">
  <ul class="wy-breadcrumbs">
      <li><a href="../index.html" class="icon icon-home" aria-label="Home"></a></li>
          <li class="breadcrumb-item"><a href="../api.html">O365 API</a></li>
      <li class="breadcrumb-item active">Group</li>
      <li class="wy-breadcrumbs-aside">
            <a href="../_sources/api/group.rst.txt" rel="nofollow"> View page source</a>
      </li>
  </ul><div class="rst-breadcrumbs-buttons" role="navigation" aria-label="Sequential page navigation">
        <a href="excel.html" class="btn btn-neutral float-left" title="Excel" accesskey="p"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="mailbox.html" class="btn btn-neutral float-right" title="Mailbox" accesskey="n">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
  </div>
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
             
  <section id="group">
<h1>Group<a class="headerlink" href="#group" title="Link to this heading"></a></h1>
<dl class="py class" id="module-O365.groups">
<dt class="sig sig-object py" id="O365.groups.Group">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.groups.</span></span><span class="sig-name descname"><span class="pre">Group</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Group"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Group" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<p>A Microsoft 365 group</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Group.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Group.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Group.__init__" title="Link to this definition"></a></dt>
<dd><p>A Microsoft 365 group</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="teams.html#O365.teams.Teams" title="O365.teams.Teams"><em>Teams</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Group.get_group_members">
<span class="sig-name descname"><span class="pre">get_group_members</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">recursive</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">False</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Group.get_group_members"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Group.get_group_members" title="Link to this definition"></a></dt>
<dd><p>Returns members of given group
:param bool recursive: drill down to users if group has other group as a member
:rtype: list[User]</p>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Group.get_group_owners">
<span class="sig-name descname"><span class="pre">get_group_owners</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Group.get_group_owners"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Group.get_group_owners" title="Link to this definition"></a></dt>
<dd><p>Returns owners of given group</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[<a class="reference internal" href="directory.html#O365.directory.User" title="O365.directory.User">User</a>]</p>
</dd>
</dl>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.description">
<span class="sig-name descname"><span class="pre">description</span></span><a class="headerlink" href="#O365.groups.Group.description" title="Link to this definition"></a></dt>
<dd><p>An optional description for the group. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.display_name">
<span class="sig-name descname"><span class="pre">display_name</span></span><a class="headerlink" href="#O365.groups.Group.display_name" title="Link to this definition"></a></dt>
<dd><p>The display name for the group. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.mail">
<span class="sig-name descname"><span class="pre">mail</span></span><a class="headerlink" href="#O365.groups.Group.mail" title="Link to this definition"></a></dt>
<dd><p>The SMTP address for the group, for example, “<a class="reference external" href="mailto:serviceadmins&#37;&#52;&#48;contoso&#46;com">serviceadmins<span>&#64;</span>contoso<span>&#46;</span>com</a>”. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.mail_nickname">
<span class="sig-name descname"><span class="pre">mail_nickname</span></span><a class="headerlink" href="#O365.groups.Group.mail_nickname" title="Link to this definition"></a></dt>
<dd><p>The mail alias for the group, unique for Microsoft 365 groups in the organization. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.object_id">
<span class="sig-name descname"><span class="pre">object_id</span></span><a class="headerlink" href="#O365.groups.Group.object_id" title="Link to this definition"></a></dt>
<dd><p>The unique identifier for the group. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.type">
<span class="sig-name descname"><span class="pre">type</span></span><a class="headerlink" href="#O365.groups.Group.type" title="Link to this definition"></a></dt>
<dd><p>The group type. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

<dl class="py attribute">
<dt class="sig sig-object py" id="O365.groups.Group.visibility">
<span class="sig-name descname"><span class="pre">visibility</span></span><a class="headerlink" href="#O365.groups.Group.visibility" title="Link to this definition"></a></dt>
<dd><p>Specifies the group join policy and group content visibility for groups. <div style="line-height: 0; padding: 0; margin: 0"></div><div style="line-height: 0; padding: 0; margin: 0"></div>&nbsp;&nbsp; <strong>Type:</strong> str</p>
</dd></dl>

</dd></dl>

<dl class="py class">
<dt class="sig sig-object py" id="O365.groups.Groups">
<em class="property"><span class="k"><span class="pre">class</span></span><span class="w"> </span></em><span class="sig-prename descclassname"><span class="pre">O365.groups.</span></span><span class="sig-name descname"><span class="pre">Groups</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Groups"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Groups" title="Link to this definition"></a></dt>
<dd><p>Bases: <a class="reference internal" href="utils/utils.html#O365.utils.utils.ApiComponent" title="O365.utils.utils.ApiComponent"><code class="xref py py-class docutils literal notranslate"><span class="pre">ApiComponent</span></code></a></p>
<p>A microsoft groups class
In order to use the API following permissions are required.
Delegated (work or school account) - Group.Read.All, Group.ReadWrite.All</p>
<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Groups.__init__">
<span class="sig-name descname"><span class="pre">__init__</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="keyword-only-separator o"><abbr title="Keyword-only parameters separator (PEP 3102)"><span class="pre">*</span></abbr></span></em>, <em class="sig-param"><span class="n"><span class="pre">parent</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">con</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="o"><span class="pre">**</span></span><span class="n"><span class="pre">kwargs</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Groups.__init__"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Groups.__init__" title="Link to this definition"></a></dt>
<dd><p>A Teams object</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>parent</strong> (<a class="reference internal" href="account.html#O365.account.Account" title="O365.account.Account"><em>Account</em></a>) – parent object</p></li>
<li><p><strong>con</strong> (<a class="reference internal" href="connection.html#O365.connection.Connection" title="O365.connection.Connection"><em>Connection</em></a>) – connection to use if no parent specified</p></li>
<li><p><strong>protocol</strong> (<a class="reference internal" href="connection.html#O365.connection.Protocol" title="O365.connection.Protocol"><em>Protocol</em></a>) – protocol to use if no parent specified
(kwargs)</p></li>
<li><p><strong>main_resource</strong> (<em>str</em>) – use this resource instead of parent resource
(kwargs)</p></li>
</ul>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Groups.get_group_by_id">
<span class="sig-name descname"><span class="pre">get_group_by_id</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Groups.get_group_by_id"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Groups.get_group_by_id" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD group with given id</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>group_id</strong> – group id of group</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#O365.groups.Group" title="O365.groups.Group">Group</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Groups.get_group_by_mail">
<span class="sig-name descname"><span class="pre">get_group_by_mail</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">group_mail</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Groups.get_group_by_mail"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Groups.get_group_by_mail" title="Link to this definition"></a></dt>
<dd><p>Returns Microsoft 365/AD group by mail field</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><p><strong>group_name</strong> – mail of group</p>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p><a class="reference internal" href="#O365.groups.Group" title="O365.groups.Group">Group</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Groups.get_user_groups">
<span class="sig-name descname"><span class="pre">get_user_groups</span></span><span class="sig-paren">(</span><em class="sig-param"><span class="n"><span class="pre">user_id</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">limit</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em>, <em class="sig-param"><span class="n"><span class="pre">batch</span></span><span class="o"><span class="pre">=</span></span><span class="default_value"><span class="pre">None</span></span></em><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Groups.get_user_groups"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Groups.get_user_groups" title="Link to this definition"></a></dt>
<dd><p>Returns list of groups that given user has membership</p>
<dl class="field-list simple">
<dt class="field-odd">Parameters<span class="colon">:</span></dt>
<dd class="field-odd"><ul class="simple">
<li><p><strong>user_id</strong> – user_id</p></li>
<li><p><strong>limit</strong> (<em>int</em>) – max no. of groups to get. Over 999 uses batch.</p></li>
<li><p><strong>batch</strong> (<em>int</em>) – batch size, retrieves items in
batches allowing to retrieve more items than the limit.</p></li>
</ul>
</dd>
<dt class="field-even">Return type<span class="colon">:</span></dt>
<dd class="field-even"><p>list[<a class="reference internal" href="#O365.groups.Group" title="O365.groups.Group">Group</a>] or <a class="reference internal" href="utils/utils.html#O365.utils.utils.Pagination" title="O365.utils.utils.Pagination">Pagination</a></p>
</dd>
</dl>
</dd></dl>

<dl class="py method">
<dt class="sig sig-object py" id="O365.groups.Groups.list_groups">
<span class="sig-name descname"><span class="pre">list_groups</span></span><span class="sig-paren">(</span><span class="sig-paren">)</span><a class="reference internal" href="../_modules/O365/groups.html#Groups.list_groups"><span class="viewcode-link"><span class="pre">[source]</span></span></a><a class="headerlink" href="#O365.groups.Groups.list_groups" title="Link to this definition"></a></dt>
<dd><p>Returns list of groups</p>
<dl class="field-list simple">
<dt class="field-odd">Return type<span class="colon">:</span></dt>
<dd class="field-odd"><p>list[<a class="reference internal" href="#O365.groups.Group" title="O365.groups.Group">Group</a>]</p>
</dd>
</dl>
</dd></dl>

</dd></dl>

</section>


           </div>
          </div>
          <footer><div class="rst-footer-buttons" role="navigation" aria-label="Footer">
        <a href="excel.html" class="btn btn-neutral float-left" title="Excel" accesskey="p" rel="prev"><span class="fa fa-arrow-circle-left" aria-hidden="true"></span> Previous</a>
        <a href="mailbox.html" class="btn btn-neutral float-right" title="Mailbox" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right" aria-hidden="true"></span></a>
    </div>

  <hr/>

  <div role="contentinfo">
    <p>&#169; Copyright 2025, alejcas.</p>
  </div>

  Built with <a href="https://www.sphinx-doc.org/">Sphinx</a> using a
    <a href="https://github.com/readthedocs/sphinx_rtd_theme">theme</a>
    provided by <a href="https://readthedocs.org">Read the Docs</a>.
   

</footer>
        </div>
      </div>
    </section>
  </div>
  <script>
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
  </script> 

</body>
</html>